/*  
 *  Copyright 2006 Paul Jack.
 *
 *  This file is part of the Dex compiler suite. 
 *  
 *  Dex is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published by the
 *  Free Software Foundation; either version 2 of the License, or (at your
 *  option) any later version.
 *  
 *  Dex is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
 *  Public License for more details.
 *  
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
package dex.compiler.model.definition;


import dex.compiler.model.type.TypeNode;


/**
 * A global variable, class field or formal parameter definition.
 */
public class TypedName extends Member {


	/**
	 * The data type for the thing being defined.
	 */
	private TypeNode type;

	
	/**
	 * Constructs a new typed name.
	 * 
	 * @param params  the name, place, modifier, attributes and comment
	 * @param type    the data type
	 */
	public TypedName(DefinitionParams params, TypeNode type) {
		super(params);
		if (type == null) {
			throw new IllegalArgumentException("type may not be null");
		}
		this.type = type;
	}


	/**
	 * Returns the data type.
	 * 
	 * @return  the type
	 */
	public TypeNode getType() {
		return type;
	}
	
	
	/**
	 * Returns the data type.  This always returns the same thing
	 * as {@link #getType()}.
	 * 
	 * @return  the type
	 */
	public TypeNode getMemberType() {
		return type;
	}
	

	@Override
	public String toString() {
		StringBuilder result = new StringBuilder();
		print(result);
		result.append(getType()).append(' ').append(getName());
		return result.toString();
	}


}
